DigiOffice Gateway Web Services

ProcessProjectRequestMessage

**ProcessProjectRequestMessage** Parameters:
Name	Parameter	Data Type	Required	Description
InstanceId	query	Guid	No
ProjectRequest	query	ProjectRequestMessage	No

**ProjectRequestMessage** Parameters:
Name	Parameter	Data Type	Required
Header	form	Header	No
ProjectReference	form	Reference	No
IncludeHousingTypes	form	bool	No
IncludeConstructionBlocks	form	bool	No
IncludeConstructionNumbers	form	bool	No
IncludeDocuments	form	bool	No
IncludePurchaseContracts	form	bool	No

**Header** Parameters:
Name	Parameter	Data Type	Required
MessageID	form	string	No
Timestamp	form	DateTime	No
Sender	form	Party	No
Recipient	form	Party	No
RequestMessageID	form	Object	No

**Party** Parameters:
Name	Parameter	Data Type	Required
Title	form	string	No
Code	form	string	No
Version	form	string	No
Environment	form	Environment	No

**Environment** Parameters:
Name	Parameter	Data Type	Required	Description
Title	form	string	No
Code	form	string	No

**Reference** Parameters:
Name	Parameter	Data Type	Required	Description
GlobalID	form	string	No
Title	form	string	No

**ProjectResponseMessage** Parameters:
Name	Parameter	Data Type	Required
Header	form	Header	No
ProjectReference	form	Reference	No
Project	form	Project	No
HousingTypes	form	HousingType[]	No
ConstructionBlocks	form	ConstructionBlock[]	No
ConstructionNumbers	form	ConstructionNumber[]	No
Documents	form	Document[]	No
PurchaseContracts	form	PurchaseContract[]	No

**Project** Parameters:
Name	Parameter	Data Type	Required
GlobalID	form	string	No
CreationDate	form	DateTime?	No
CreatedBy	form	string	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	string	No
Code	form	string	No
Name	form	string	No
Description1	form	string	No
Description2	form	string	No
Address	form	Address	No
MailingAddress	form	MailingAddress	No
ProjectCategoryReference	form	Reference	No
ProjectTypeReference	form	Reference	No
ProjectStatusReference	form	Reference	No
StartDate	form	DateTime?	No
EndDate	form	DateTime?	No
CompletionDate	form	DateTime?	No
Inactive	form	bool	No
Website	form	string	No
IsTemplateProject	form	bool	No
CustomFields	form	CustomField[]	No

**Address** Parameters:
Name	Parameter	Data Type	Required
AddressLine1	form	string	No
AddressLine2	form	string	No
HouseNumber	form	string	No
HouseNumberSuffix	form	string	No
PostalCode	form	string	No
City	form	string	No
Country	form	Reference	No

**MailingAddress** Parameters:
Name	Parameter	Data Type	Required
POBox	form	string	No
PostalCode	form	string	No
City	form	string	No
Country	form	Reference	No

**CustomField** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**HousingType** Parameters:
Name	Parameter	Data Type	Required
GlobalID	form	string	No
ProjectReference	form	Reference	No
Code	form	string	No
Description	form	string	No
CustomFields	form	CustomField[]	No
CreationDate	form	DateTime?	No
CreatedBy	form	string	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	string	No

**ConstructionBlock** Parameters:
Name	Parameter	Data Type	Required
GlobalID	form	string	No
ProjectReference	form	Reference	No
Code	form	string	No
Description	form	string	No
CustomFields	form	CustomField[]	No
CreationDate	form	DateTime?	No
CreatedBy	form	string	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	string	No

**ConstructionNumber** Parameters:
Name	Parameter	Data Type	Required
GlobalID	form	string	No
ProjectReference	form	Reference	No
HousingTypeReference	form	Reference	No
ConstructionBlockReference	form	Reference	No
Code	form	string	No
Description	form	string	No
Address	form	Address	No
RentalHouse	form	bool	No
GuaranteeCertificateNumber	form	string	No
Inactive	form	bool	No
CustomFields	form	CustomField[]	No
CreationDate	form	DateTime?	No
CreatedBy	form	string	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	string	No
ViewingDate	form	DateTime?	No
ViewingDateSpecified	form	bool	No
DeliveryDate	form	DateTime?	No
DeliveryDateSpecified	form	bool	No

**Document** Parameters:
Name	Parameter	Data Type	Required
ID	form	Guid	No
RootDocumentID	form	Guid	No
RegistrationprofileID	form	Guid	No
Title	form	string	No
FullTitle	form	string	No
Number	form	string	No
Version	form	string	No
ExternalNumber	form	string	No
ExternalVersion	form	string	No
InternalNumber	form	string	No
InternalInvoiceNumber	form	string	No
PersonID	form	int	No
RelationID	form	int	No
RelationTitle	form	string	No
ProjectID	form	int	No
ProjectTitle	form	string	No
Extension	form	string	No
Date	form	DateTime?	No
CommentsCount	form	int	No
HasComments	form	bool	No
HasPreview	form	bool	No
ExtraField	form	string	No
IsFavorite	form	bool	No
DocumentcategoryText	form	string	No
FileSize	form	long?	No
FileDate	form	DateTime?	No
Hash	form	string	No
HashType	form	string	No
FileUrl	form	string	No
StandardDocumentUrl	form	string	No
IsCorporateIdentity	form	bool	No
UserTitle	form	string	No
IsFrozen	form	bool	No
InternalCompanyID	form	int	No
DirectUrl	form	string	No
AllowDigitalSigningOnlyOnPrimaryVersions	form	bool	No
IsPrimaryVersion	form	bool	No
FileExtension	form	string	No
CustomProperties	form	Dictionary<string, Object>	No

**PurchaseContract** Parameters:
Name	Parameter	Data Type	Required
GlobalID	form	string	No
Code	form	string	No
Description	form	string	No
ProjectReference	form	Reference	No
ProductCode	form	string	No
Relation	form	Relation	No
Inactive	form	bool	No
CustomFields	form	CustomField[]	No
CreationDate	form	DateTime?	No
CreatedBy	form	string	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	string	No

**Relation** Parameters:
Name	Parameter	Data Type	Required
GlobalID	form	string	No
NameLine1	form	string	No
NameLine2	form	string	No
Address	form	Address	No
MailingAddress	form	MailingAddress	No
Telephone	form	string	No
Mobile	form	string	No
Email	form	string	No
IBAN	form	string	No
BankAccountNumber	form	string	No
Website	form	string	No
Inactive	form	bool	No
CustomFields	form	CustomField[]	No
CreationDate	form	DateTime?	No
CreatedBy	form	string	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/ProcessProjectRequestMessage HTTP/1.1 
Host: kpm_digiofficeapigateway.tbi.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectRequest: 
	{
		Header: 
		{
			MessageID: String,
			Timestamp: 0001-01-01,
			Sender: 
			{
				Title: String,
				Code: String,
				Version: String,
				Environment: 
				{
					Title: String,
					Code: String
				}
			},
			Recipient: 
			{
				Title: String,
				Code: String,
				Version: String,
				Environment: 
				{
					Title: String,
					Code: String
				}
			},
			RequestMessageID: {}
		},
		ProjectReference: 
		{
			GlobalID: String,
			Title: String
		},
		IncludeHousingTypes: False,
		IncludeConstructionBlocks: False,
		IncludeConstructionNumbers: False,
		IncludeDocuments: False,
		IncludePurchaseContracts: False
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Header: 
	{
		MessageID: String,
		Timestamp: 0001-01-01,
		Sender: 
		{
			Title: String,
			Code: String,
			Version: String,
			Environment: 
			{
				Title: String,
				Code: String
			}
		},
		Recipient: 
		{
			Title: String,
			Code: String,
			Version: String,
			Environment: 
			{
				Title: String,
				Code: String
			}
		},
		RequestMessageID: {}
	},
	ProjectReference: 
	{
		GlobalID: String,
		Title: String
	},
	Project: 
	{
		GlobalID: String,
		CreationDate: 0001-01-01,
		CreatedBy: String,
		ModifiedDate: 0001-01-01,
		ModifiedBy: String,
		Code: String,
		Name: String,
		Description1: String,
		Description2: String,
		Address: 
		{
			AddressLine1: String,
			AddressLine2: String,
			HouseNumber: String,
			HouseNumberSuffix: String,
			PostalCode: String,
			City: String,
			Country: 
			{
				GlobalID: String,
				Title: String
			}
		},
		MailingAddress: 
		{
			POBox: String,
			PostalCode: String,
			City: String,
			Country: 
			{
				GlobalID: String,
				Title: String
			}
		},
		ProjectCategoryReference: 
		{
			GlobalID: String,
			Title: String
		},
		ProjectTypeReference: 
		{
			GlobalID: String,
			Title: String
		},
		ProjectStatusReference: 
		{
			GlobalID: String,
			Title: String
		},
		StartDate: 0001-01-01,
		EndDate: 0001-01-01,
		CompletionDate: 0001-01-01,
		Inactive: False,
		Website: String,
		IsTemplateProject: False,
		CustomFields: 
		[
			{
				Name: String,
				Value: String
			}
		]
	},
	HousingTypes: 
	[
		{
			GlobalID: String,
			ProjectReference: 
			{
				GlobalID: String,
				Title: String
			},
			Code: String,
			Description: String,
			CustomFields: 
			[
				{
					Name: String,
					Value: String
				}
			],
			CreationDate: 0001-01-01,
			CreatedBy: String,
			ModifiedDate: 0001-01-01,
			ModifiedBy: String
		}
	],
	ConstructionBlocks: 
	[
		{
			GlobalID: String,
			ProjectReference: 
			{
				GlobalID: String,
				Title: String
			},
			Code: String,
			Description: String,
			CustomFields: 
			[
				{
					Name: String,
					Value: String
				}
			],
			CreationDate: 0001-01-01,
			CreatedBy: String,
			ModifiedDate: 0001-01-01,
			ModifiedBy: String
		}
	],
	ConstructionNumbers: 
	[
		{
			GlobalID: String,
			ProjectReference: 
			{
				GlobalID: String,
				Title: String
			},
			HousingTypeReference: 
			{
				GlobalID: String,
				Title: String
			},
			ConstructionBlockReference: 
			{
				GlobalID: String,
				Title: String
			},
			Code: String,
			Description: String,
			Address: 
			{
				AddressLine1: String,
				AddressLine2: String,
				HouseNumber: String,
				HouseNumberSuffix: String,
				PostalCode: String,
				City: String,
				Country: 
				{
					GlobalID: String,
					Title: String
				}
			},
			RentalHouse: False,
			GuaranteeCertificateNumber: String,
			Inactive: False,
			CustomFields: 
			[
				{
					Name: String,
					Value: String
				}
			],
			CreationDate: 0001-01-01,
			CreatedBy: String,
			ModifiedDate: 0001-01-01,
			ModifiedBy: String,
			ViewingDate: 0001-01-01,
			ViewingDateSpecified: False,
			DeliveryDate: 0001-01-01,
			DeliveryDateSpecified: False
		}
	],
	Documents: 
	[
		{
			GlobalID: String,
			RootDocumentID: String,
			Code: String,
			Subject: String,
			VersionNumber: String,
			NewestVersion: False,
			RelationReference: 
			{
				GlobalID: String,
				Title: String
			},
			DocumentTypeReference: 
			{
				GlobalID: String,
				Title: String
			},
			ProjectReference: 
			{
				GlobalID: String,
				Title: String
			},
			ConstructionBlockReference: 
			{
				GlobalID: String,
				Title: String
			},
			ConstructionNumberReference: 
			{
				GlobalID: String,
				Title: String
			},
			HousingTypeReference: 
			{
				GlobalID: String,
				Title: String
			},
			Floor: 0,
			FloorSpecified: False,
			DeletedDate: 0001-01-01,
			DeletedDateSpecified: False,
			File: 
			{
				Type: String,
				Name: String,
				Size: 0,
				Content: String,
				ModifiedDate: 0001-01-01
			},
			CustomFields: 
			[
				{
					Name: String,
					Value: String
				}
			],
			CreationDate: 0001-01-01,
			CreatedBy: String,
			ModifiedDate: 0001-01-01,
			ModifiedBy: String
		}
	],
	PurchaseContracts: 
	[
		{
			GlobalID: String,
			Code: String,
			Description: String,
			ProjectReference: 
			{
				GlobalID: String,
				Title: String
			},
			ProductCode: String,
			Relation: 
			{
				GlobalID: String,
				NameLine1: String,
				NameLine2: String,
				Address: 
				{
					AddressLine1: String,
					AddressLine2: String,
					HouseNumber: String,
					HouseNumberSuffix: String,
					PostalCode: String,
					City: String,
					Country: 
					{
						GlobalID: String,
						Title: String
					}
				},
				MailingAddress: 
				{
					POBox: String,
					PostalCode: String,
					City: String,
					Country: 
					{
						GlobalID: String,
						Title: String
					}
				},
				Telephone: String,
				Mobile: String,
				Email: String,
				IBAN: String,
				BankAccountNumber: String,
				Website: String,
				Inactive: False,
				CustomFields: 
				[
					{
						Name: String,
						Value: String
					}
				],
				CreationDate: 0001-01-01,
				CreatedBy: String,
				ModifiedDate: 0001-01-01,
				ModifiedBy: String
			},
			Inactive: False,
			CustomFields: 
			[
				{
					Name: String,
					Value: String
				}
			],
			CreationDate: 0001-01-01,
			CreatedBy: String,
			ModifiedDate: 0001-01-01,
			ModifiedBy: String
		}
	]
}